Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Actions api paths changes #415

Merged
merged 10 commits into from
Sep 27, 2023
Merged

Actions api paths changes #415

merged 10 commits into from
Sep 27, 2023

Conversation

cvaroqui
Copy link
Member

Use the following api paths model:

/namespaces////

Use the following api paths model:

/namespaces/<ns>/<kind>/<name>/<action>
Use a "object / <kind>" pattern for openapi handler tags.
Expose in each object kind section this triplet of handlers:

GET /namespaces/{namespace}/{kind}/{name}
GET /namespaces/{namespace}/{kind}/{name}/config
GET /namespaces/{namespace}/{kind}/{name}/file
New paths:

* /cluster/freeze
* /cluster/unfreeze
* /node/drain
Add:

*  GET /namespaces/{namespace}/{kind}/{name}/instance/logs
*  GET /namespaces/{namespace}/{kind}/{name}/instance/backlogs

Rename:

* GET /object/logs => /instances/logs
* GET /object/backlogs => /instances/backlogs
So the filename shows its instances nature.
They must not require the paths query parm, as the object path
is passed from the path parms.
to POST /namespaces/{namespace}/{kind}/{name}/instance/clear
Use the same handler for different kinds.

Use openapi handler tags to present the handler only in the
supported kinds.
@cvaroqui cvaroqui merged commit 886d775 into opensvc:main Sep 27, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant